<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>CSD462 Library Documentation: CSD462::Viewer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">CSD462 Library Documentation
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Computer Graphics</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>CSD462</b></li><li class="navelem"><a class="el" href="class_c_s_d462_1_1_viewer.html">Viewer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_c_s_d462_1_1_viewer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CSD462::Viewer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Provides OpenGL context, window display, and event handling routines.  
 <a href="class_c_s_d462_1_1_viewer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="viewer_8h_source.html">viewer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a19d29efdf881d9ac2a257e592a5d2f3e">Viewer</a> (void)</td></tr>
<tr class="memdesc:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a19d29efdf881d9ac2a257e592a5d2f3e">More...</a><br /></td></tr>
<tr class="separator:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9cc961cc9a3966f9191a1ddad256642"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#ad9cc961cc9a3966f9191a1ddad256642">Viewer</a> (const char *title)</td></tr>
<tr class="memdesc:ad9cc961cc9a3966f9191a1ddad256642"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad9cc961cc9a3966f9191a1ddad256642">More...</a><br /></td></tr>
<tr class="separator:ad9cc961cc9a3966f9191a1ddad256642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934c617c4669a38c6b097b96acbd3dde"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a934c617c4669a38c6b097b96acbd3dde">~Viewer</a> (void)</td></tr>
<tr class="memdesc:a934c617c4669a38c6b097b96acbd3dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a934c617c4669a38c6b097b96acbd3dde">More...</a><br /></td></tr>
<tr class="separator:a934c617c4669a38c6b097b96acbd3dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a020f41a5af51fd3d797f22d414da43f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a020f41a5af51fd3d797f22d414da43f1">init</a> (void)</td></tr>
<tr class="memdesc:a020f41a5af51fd3d797f22d414da43f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the viewer.  <a href="#a020f41a5af51fd3d797f22d414da43f1">More...</a><br /></td></tr>
<tr class="separator:a020f41a5af51fd3d797f22d414da43f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4b8928c167634cb882081dd63294735"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#ab4b8928c167634cb882081dd63294735">start</a> (void)</td></tr>
<tr class="memdesc:ab4b8928c167634cb882081dd63294735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the drawing loop of the viewer.  <a href="#ab4b8928c167634cb882081dd63294735">More...</a><br /></td></tr>
<tr class="separator:ab4b8928c167634cb882081dd63294735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a024db44ae25cd5e4d9110c0530f71520"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a024db44ae25cd5e4d9110c0530f71520">set_renderer</a> (<a class="el" href="class_c_s_d462_1_1_renderer.html">Renderer</a> *renderer)</td></tr>
<tr class="memdesc:a024db44ae25cd5e4d9110c0530f71520"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a user space renderer.  <a href="#a024db44ae25cd5e4d9110c0530f71520">More...</a><br /></td></tr>
<tr class="separator:a024db44ae25cd5e4d9110c0530f71520"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides OpenGL context, window display, and event handling routines. </p>
<p>A user application may draw to the window's context by providing a user renderer. The viewer manages other display components such as the zoom views, text OSD, etc. It also takes care of window event handling and event passing, through which the renderer may interact with user inputs. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a19d29efdf881d9ac2a257e592a5d2f3e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::Viewer </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Creates a new viewer with the default title (CSD462). </p>

</div>
</div>
<a class="anchor" id="ad9cc961cc9a3966f9191a1ddad256642"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::Viewer </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>title</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Creates a new viweer with the given title. </p>

</div>
</div>
<a class="anchor" id="a934c617c4669a38c6b097b96acbd3dde"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::~Viewer </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>Destroys the viewer instance and frees memory. Note that this does not change the user space renderer. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a020f41a5af51fd3d797f22d414da43f1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the viewer. </p>
<p>This will open up a window and install all the event handlers and make the viewer ready for drawing. </p>

</div>
</div>
<a class="anchor" id="ab4b8928c167634cb882081dd63294735"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::start </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start the drawing loop of the viewer. </p>
<p>Once called this will block until the viewer is close. </p>

</div>
</div>
<a class="anchor" id="a024db44ae25cd5e4d9110c0530f71520"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::set_renderer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_c_s_d462_1_1_renderer.html">Renderer</a> *&#160;</td>
          <td class="paramname"><em>renderer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set a user space renderer. </p>
<p>The viewer will use the given user space renderer in drawing. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">renderer</td><td>The user space renderer to use in the viewer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/<a class="el" href="viewer_8h_source.html">viewer.h</a></li>
<li>lib/viewer.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 1 2015 14:30:00 for CSD462 Library Documentation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
